home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sstegr.z / sstegr
Encoding:
Text File  |  2002-10-03  |  9.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSTEGR - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric tridiagonal matrix T
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSTEGR( JOBZ, RANGE, N, D, E, VL, VU, IL, IU, ABSTOL, M, W, Z,
  14.                         LDZ, ISUPPZ, WORK, LWORK, IWORK, LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, LIWORK, LWORK, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        ISUPPZ( * ), IWORK( * )
  23.  
  24.          REAL           D( * ), E( * ), W( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      SSTEGR computes selected eigenvalues and, optionally, eigenvectors of a
  41.      real symmetric tridiagonal matrix T. Eigenvalues and
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.         (a) Compute T - sigma_i = L_i D_i L_i^T, such that L_i D_i L_i^T
  49.             is a relatively robust representation,
  50.         (b) Compute the eigenvalues, lambda_j, of L_i D_i L_i^T to high
  51.             relative accuracy by the dqds algorithm,
  52.         (c) If there is a cluster of close eigenvalues, "choose" sigma_i
  53.             close to the cluster, and go to step (a),
  54.         (d) Given the approximate eigenvalue lambda_j of L_i D_i L_i^T,
  55.             compute the corresponding eigenvector by forming a
  56.             rank-revealing twisted factorization.
  57.      The desired accuracy of the output can be specified by the input
  58.      parameter ABSTOL.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      For more details, see "A new O(n^2) algorithm for the symmetric
  75.      tridiagonal eigenvalue/eigenvector problem", by Inderjit Dhillon,
  76.      Computer Science Division Technical Report No. UCB/CSD-97-971, UC
  77.      Berkeley, May 1997.
  78.  
  79.      Note 1 : Currently SSTEGR is only set up to find ALL the n eigenvalues
  80.      and eigenvectors of T in O(n^2) time
  81.      Note 2 : Currently the routine SSTEIN is called when an appropriate
  82.      sigma_i cannot be chosen in step (c) above. SSTEIN invokes modified
  83.      Gram-Schmidt when eigenvalues are close.
  84.      Note 3 : SSTEGR works only on machines which follow ieee-754 floating-
  85.      point standard in their handling of infinities and NaNs.  Normal
  86.      execution of SSTEGR may create NaNs and infinities and hence may abort
  87.      due to a floating point exception in environments which do not conform to
  88.      the ieee standard.
  89.  
  90.  
  91. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  92.      JOBZ    (input) CHARACTER*1
  93.              = 'N':  Compute eigenvalues only;
  94.              = 'V':  Compute eigenvalues and eigenvectors.
  95.  
  96.      RANGE   (input) CHARACTER*1
  97.              = 'A': all eigenvalues will be found.
  98.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  99.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  100.  
  101.      N       (input) INTEGER
  102.              The order of the matrix.  N >= 0.
  103.  
  104.      D       (input/output) REAL array, dimension (N)
  105.              On entry, the n diagonal elements of the tridiagonal matrix T. On
  106.              exit, D is overwritten.
  107.  
  108.      E       (input/output) REAL array, dimension (N)
  109.              On entry, the (n-1) subdiagonal elements of the tridiagonal
  110.              matrix T in elements 1 to N-1 of E; E(N) need not be set.  On
  111.              exit, E is overwritten.
  112.  
  113.      VL      (input) REAL
  114.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  115.              the interval to be searched for eigenvalues. VL < VU.  Not
  116.              referenced if RANGE = 'A' or 'I'.
  117.  
  118.      IL      (input) INTEGER
  119.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  120.              order) of the smallest and largest eigenvalues to be returned.  1
  121.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  122.              referenced if RANGE = 'A' or 'V'.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      ABSTOL  (input) REAL
  141.              The absolute error tolerance for the eigenvalues/eigenvectors. IF
  142.              JOBZ = 'V', the eigenvalues and eigenvectors output have residual
  143.              norms bounded by ABSTOL, and the dot products between different
  144.              eigenvectors are bounded by ABSTOL. If ABSTOL is less than
  145.              N*EPS*|T|, then N*EPS*|T| will be used in its place, where EPS is
  146.              the machine precision and |T| is the 1-norm of the tridiagonal
  147.              matrix. The eigenvalues are computed to an accuracy of EPS*|T|
  148.              irrespective of ABSTOL. If high relative accuracy is important,
  149.              set ABSTOL to DLAMCH( 'Safe minimum' ).  See Barlow and Demmel
  150.              "Computing Accurate Eigensystems of Scaled Diagonally Dominant
  151.              Matrices", LAPACK Working Note #7 for a discussion of which
  152.              matrices define their eigenvalues to high relative accuracy.
  153.  
  154.      M       (output) INTEGER
  155.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  156.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  157.  
  158.      W       (output) REAL array, dimension (N)
  159.              The first M elements contain the selected eigenvalues in
  160.              ascending order.
  161.  
  162.      Z       (output) REAL array, dimension (LDZ, max(1,M) )
  163.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  164.              the orthonormal eigenvectors of the matrix T corresponding to the
  165.              selected eigenvalues, with the i-th column of Z holding the
  166.              eigenvector associated with W(i).  If JOBZ = 'N', then Z is not
  167.              referenced.  Note: the user must ensure that at least max(1,M)
  168.              columns are supplied in the array Z; if RANGE = 'V', the exact
  169.              value of M is not known in advance and an upper bound must be
  170.              used.
  171.  
  172.      LDZ     (input) INTEGER
  173.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  174.              'V', LDZ >= max(1,N).
  175.  
  176.      ISUPPZ  (output) INTEGER ARRAY, dimension ( 2*max(1,M) )
  177.              The support of the eigenvectors in Z, i.e., the indices
  178.              indicating the nonzero elements in Z. The i-th eigenvector is
  179.              nonzero only in elements ISUPPZ( 2*i-1 ) through ISUPPZ( 2*i ).
  180.  
  181.      WORK    (workspace/output) REAL array, dimension (LWORK)
  182.              On exit, if INFO = 0, WORK(1) returns the optimal (and minimal)
  183.              LWORK.
  184.  
  185.      LWORK   (input) INTEGER
  186.              The dimension of the array WORK.  LWORK >= max(1,18*N)
  187.  
  188.              If LWORK = -1, then a workspace query is assumed; the routine
  189.              only calculates the optimal size of the WORK array, returns this
  190.              value as the first entry of the WORK array, and no error message
  191.              related to LWORK is issued by XERBLA.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEGGGGRRRR((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  207.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  208.  
  209.      LIWORK  (input) INTEGER
  210.              The dimension of the array IWORK.  LIWORK >= max(1,10*N)
  211.  
  212.              If LIWORK = -1, then a workspace query is assumed; the routine
  213.              only calculates the optimal size of the IWORK array, returns this
  214.              value as the first entry of the IWORK array, and no error message
  215.              related to LIWORK is issued by XERBLA.
  216.  
  217.      INFO    (output) INTEGER
  218.              = 0:  successful exit
  219.              < 0:  if INFO = -i, the i-th argument had an illegal value
  220.              > 0:  if INFO = 1, internal error in SLARRE, if INFO = 2,
  221.              internal error in SLARRV.
  222.  
  223. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  224.      Based on contributions by
  225.         Inderjit Dhillon, IBM Almaden, USA
  226.         Osni Marques, LBNL/NERSC, USA
  227.  
  228.  
  229. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  230.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  231.  
  232.      This man page is available only online.
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.